Skip to main content
GET
/
api
/
v1
/
sessions
/
{session_id}
/
insights
/
{job_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "clusters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "level": 123,
      "name": "<string>",
      "description": "<string>",
      "num_runs": 123,
      "stats": {},
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_name": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "metadata": {},
  "shape": {},
  "error": "<string>",
  "config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "report": {
    "key_points": [
      "<string>"
    ],
    "title": "<string>",
    "highlighted_traces": [
      {
        "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rank": 123,
        "highlight_reason": "<string>",
        "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "cluster_name": "<string>",
        "summary": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
session_id
string<uuid>
required
​
job_id
string<uuid>
required

Response

Successful Response

Response to get a specific cluster job for a session.

​
id
string<uuid>
required
​
name
string
required
​
status
string
required
​
created_at
string<date-time>
required
​
clusters
RunCluster · object[]
required
​
start_time
string<date-time> | null
​
end_time
string<date-time> | null
​
metadata
Metadata · object
​
shape
Shape · object
​
error
string | null
​
config_id
string<uuid> | null
​
report
InsightsSummary · object

High level summary of an insights job that pulls out patterns and specific traces.